Skip to content

Update documentation: ImGui, Qt, and Python env#522

Merged
bakpaul merged 7 commits intosofa-framework:masterfrom
hugtalbot:202507_update_doc_imgui
Jul 24, 2025
Merged

Update documentation: ImGui, Qt, and Python env#522
bakpaul merged 7 commits intosofa-framework:masterfrom
hugtalbot:202507_update_doc_imgui

Conversation

@hugtalbot
Copy link
Contributor

This PR aims at improving the doc :

  • introducing ImGui everywhere in the examples
  • keeping a mention about how to run Qt based GUI
  • clarify the use of SOFA within a Python environment

.. code-block:: shell

runSofa examples/example1.py
runSofa example.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we mention at one point the necessity to load SofaPython3 here ?
Add :

💡 To make sure runSofa is able to load a .py scene, either open runSofa without any argument once and add libSofaPython3 in the plugin manager or add -l SofaPython3 in this command line. For more information see link to 'using the plugin doc'

@bakpaul bakpaul merged commit d02c833 into sofa-framework:master Jul 24, 2025
4 checks passed
RafaelPalomar pushed a commit to Slicer/SofaPython3 that referenced this pull request Jan 28, 2026
* Update documentation to explicit the use of ImGui and SOFA in Python

* add description to use SofaQt

* clarify and clean the installation section

* Rename example1 as example

* simplify writing for ImGui use

* Apply suggestions from code review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request pr: status ready

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants